How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Logz.io

Logz.io Users API

List, create, update, suspend, and delete users in the main account and across all associated sub-accounts. Includes authentication groups (SSO group-to-role mappings), the `whoami` introspection endpoint, and `associated-accounts` for navigating the multi-account hierarchy.

Documentation Provider Profile APIs.io OpenAPI GitHub

Logz.io Users API is one of 19 APIs that Logz.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account Management, User, and Identity. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 205 operations across 148 paths, organized into 57 resource areas, and defines 154 schemas. It is described by OpenAPI 2.0.

Requests are made against the base URL https://api.logz.io/v1/user-management.

205 operations 148 paths 154 schemas 28 DELETE69 GET1 PATCH75 POST32 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
Base URL
https://api.logz.io/v1/user-management
Authentication
API Key
Contact
https://docs.logz.io/
License
Apache 2.0
Terms of Service
View terms
Resource Areas
57

Authentication & Security 1

Logz.io Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-TOKEN (X-API-TOKEN). By default, every request must be authenticated.

  • X-API-TOKEN — You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io//dashboard/settings/manage-tokens/api) page. API tokens are account-specific.…

Paths & Operations 205

Across 148 paths, the API surfaces 205 operations — 28 DELETE, 69 GET, 1 PATCH, 75 POST, 32 PUT. They span 57 resource areas, including Query, Range Query, Time Series, Labels, Label Values, Dashboards get all, Dashboards get by ID, Dashboards create new, and 49 more. Each is listed below with its method, path, parameters, and response codes.

Query 2
GET
/v1/metrics/prometheus/api/v1/query
Evaluates an instant query at a single point in time
GetInstantQuery 3 params → 200400500
POST
/v1/metrics/prometheus/api/v1/query
Evaluates an instant query at a single point in time using POST
PostInstantQuery 3 params → 200400500
Range Query 2
GET
/v1/metrics/prometheus/api/v1/query_range
Evaluates an expression query over a range of time
GetRangeQuery 5 params → 200400500
POST
/v1/metrics/prometheus/api/v1/query_range
Evaluates an expression query over a range of time using POST
PostRangeQuery 5 params → 200400500
Time Series 2
GET
/v1/metrics/prometheus/api/v1/series
Returns the list of time series that match a certain label set.
GetSeriesByLabels 4 params → 200400500
POST
/v1/metrics/prometheus/api/v1/series
Returns the list of time series that match a certain label set using POST.
PostSeriesByLabels 4 params → 200400500
Labels 2
GET
/v1/metrics/prometheus/api/v1/labels
Returns a list of label names
GetLabelNames 4 params → 200400500
POST
/v1/metrics/prometheus/api/v1/labels
Returns a list of label names using POST
PostLabelNames 4 params → 200400500
Label Values 1
GET
/v1/metrics/prometheus/api/v1/label/{label_name}/values
Returns a list of label values for a provided label name
GetLabelValues 5 params → 200400500
Dashboards get all 1
GET
/perses-public/api/v1/dashboards
Get all dashboards
1 param → 200
Dashboards get by ID 1
GET
/perses-public/api/v1/projects/{folderId}/dashboards/{uid}
Get dashboard by ID
1 param → 200
Dashboards create new 1
POST
/perses-public/api/v1/projects/{folderId}/dashboards
Create a new dashboard
2 params → 201
Dashboards update 1
PUT
/perses-public/api/v1/projects/{folderId}/dashboards/{uid}/
Update an existing dashboard
3 params → 200
Dashboards delete 1
DELETE
/perses-public/api/v1/projects/{folderId}/dashboards/{uid}/1
Delete a dashboard
2 params → 204404
Dashboards move 1
POST
/perses-public/api/v1/dashboards/move
Move a dashboard to a different folder
1 param → 200
Dashboards get by user 1
GET
/perses-public/api/v1/dashboards/users
Get dashboard by user
1 param → 200
Dashboards get all global data sources 1
GET
/perses-public/api/v1/globaldatasources
Get all global data sources
→ 200
Dashboards get all folders 1
GET
/perses-public/api/v1/projects
Get all dashboards folders
1 param → 200
Dashboards create new folder 1
POST
/perses-public/api/v1/projects/
Create dashboards folder
1 param → 201
Dashboards delete folder 1
DELETE
/perses-public/api/v1/projects/{folderId}
Delete dashboard folder
1 param → 204404401400403409500
Dashboards get folder by name 1
GET
/perses-public/api/v1/projects/{name}
Get dashboard folder by name
1 param → 200
Dashboards rename folder 1
PUT
/perses-public/api/v1/projects/{folderId}/rename
Rename dashboard folder
2 params → 200
Dashboards search folder 1
GET
/perses-public/api/v1/projects/search
Search dashboard folders
4 params → 200
Dashboards update folder 1
PUT
/perses-public/api/v1/projects/{name}1
Update dashboard folder
2 params → 200
Grafana Folders 5
GET
/v1/grafana/api/folders
Get all folders
getAllFolders 3 params → 200
POST
/v1/grafana/api/folders
Create a new Grafana folder
createNewGrafanaFolder 1 param → 200
GET
/v1/grafana/api/folders/{uid}
Get Grafana folder by UID
getGrafanaFolderByUid 1 param → 200
PUT
/v1/grafana/api/folders/{uid}
Update a Grafana folder by UID
updateGrafanaFolderByUid 2 params → 200
DELETE
/v1/grafana/api/folders/{uid}
Delete a Grafana folder by UID
deleteGrafanaFolderByUid 1 param → 204404400
Grafana contact points 7
GET
/v1/grafana/api/v1/provisioning/contact-points
Get all contact points
RouteGetContactpoints 1 param → 200descriptionschema
POST
/v1/grafana/api/v1/provisioning/contact-points
Create a contact point
RoutePostContactpoints 1 param → 202descriptionschema400
DELETE
/v1/grafana/api/v1/provisioning/contact-points/<>
Delete a contact point
RouteDeleteContactpoints 1 param → 204
PUT
/v1/grafana/api/v1/provisioning/contact-points/<>
Update a contact point
RouteUpdateContactpoints 2 params → 202204400
DELETE
/v1/grafana/api/v1/provisioning/policies
Clears the notification policy tree
RouteResetPolicyTree → 202
GET
/v1/grafana/api/v1/provisioning/policies
Get notification policy tree
RouteGetPolicyTree → 202
PUT
/v1/grafana/api/v1/provisioning/policies
Set notification policy tree
RouteSetPolicyTree 1 param → 202400
Grafana data source 2
GET
/v1/grafana/api/datasources/summary
Return a list of data sources
getAllDatasources → 200404
GET
/v1/grafana/api/datasources/name/{metric_account_name}/summary
Get a data source for a given account
getDatasourceByAccount 1 param → 200404
Grafana alerting provisioning 4
GET
/v1/grafana/api/v1/provisioning/alert-rules
Return a list of all alerts
getAlertRules 2 params → 200
POST
/v1/grafana/api/v1/provisioning/alert-rules
Create a new alert rule
AlertRules 1 param → 200
GET
/v1/grafana/api/v1/provisioning/alert-rules/<>
Return a list of all alerts by UID
getAlertRulesByUID 1 param → 200
PUT
/v1/grafana/api/v1/provisioning/alert-rules/<>
Amend an alert by UID
putAlertRulesByUID 2 params → 200
Grafana annotations 8
DELETE
/v1/grafana/api/v1/provisioning/alert-rules/<>
Delete alert rule by UID
deleteAlertRulesByUID 1 param → 200
GET
/v1/grafana/api/annotations/
Find annotations
getAnnotations 9 params → 200
POST
/v1/grafana/api/annotations/
Create annotations
createAnnotations 1 param → 200
POST
/v1/grafana/api/annotations/graphite
Create annotations in Graphite format
createAnnotationsGraphite 1 param → 200
PUT
/v1/grafana/api/annotations/:id
Update annotations
updateAnnotations 2 params → 200
PATCH
/v1/grafana/api/annotations/:id
Patch annotations
patchAnnotations 2 params → 200
DELETE
/v1/grafana/api/annotations/:id
Delete annotation by id
deleteAnnotations 1 param → 200
GET
/v1/grafana/api/annotations/tags
Get event tags created in annotations
getAnnotationsTags 2 params → 200
Grafana silence management 3
GET
/v1/grafana/api/alertmanager/grafana/api/v2/silences/
Retrieve all silences
getAllSilences 1 param → 200
POST
/v1/grafana/api/alertmanager/grafana/api/v2/silences
Create new silence
createNewSilence 1 param → 200400
DELETE
/v1/grafana/api/alertmanager/grafana/api/v2/silence/<>
Delete a silence
deleteSilence 1 param → 200400
Grafana dashboards 9
POST
/v1/grafana/api/dashboards/db
Create/update a dashboard
createDashboard 1 param → 200412
GET
/v1/grafana/api/dashboards/uid/<>
Get dashboard by uid
getDashboarById 1 param → 200
DELETE
/v1/grafana/api/dashboards/uid/<>
Delete dashboard by uid
deleteDashboarById 1 param → 200
GET
/v1/grafana/api/dashboards/home
Get home dashboard
getHomeDashboard → 200
GET
/v1/grafana/api/dashboards/tags
Get all tags of dashboards
getDashboardTags → 200
GET
/v1/grafana/api/dashboards/id/:dashboardId/versions
Get all dashboard versions
getAllDashboardVersions 3 params → 200
GET
/v1/grafana/api/dashboards/id/:dashboardId/versions/:id
Get dashboard version
getDashboardVersion 2 params → 200
POST
/v1/grafana/api/dashboards/id/:dashboardId/restore
Restore a dashboard
restoreDashboard 2 params → 200
POST
/v1/grafana/api/dashboards/calculate-diff
Compare dashboards
compareDashboard 1 param → 200
Grafana dashboard search 1
GET
/v1/grafana/api/search/
Search folders and dashboards
searchDashboard 8 params → 200
Grafana snapshots 5
GET
/v1/grafana/api/dashboard/snapshots/
Get list of Snapshots
getGrafanaSnapshot 2 params → 200
POST
/v1/grafana/api/snapshots/
Create a snapshot
postGrafanaSnapshot 1 param → 200
GET
/v1/grafana/api/snapshots/:key/
Get Snapshot by Key.
getGrafanaSnapshotbyKey 1 param → 200
DELETE
/v1/grafana/api/snapshots/:key/
Delete Snapshot by Key.
deleteGrafanaSnapshotbyKey 1 param → 200
GET
/v1/grafana/api/snapshots-delete/:deleteKey
Delete snapshot by deleteKey.
deleteGrafanaSnapshotbyDeleteKey 1 param → 200
Delete object API 1
DELETE
/v1/osd/saved-objects/{object-type}/{object-id}
Remove a saved object
2 params → 200
Manage metrics account 5
POST
/v1/account-management/metrics-accounts
Create a new metrics account
1 param → 201
GET
/v1/account-management/metrics-accounts
Get a list of all metrics accounts
→ 200
PUT
/v1/account-management/metrics-accounts/{metricsAccountId}
Update a metrics account
2 params → 200
DELETE
/v1/account-management/metrics-accounts/{metricsAccountId}
Delete a metrics account
1 param → 200
GET
/v1/account-management/metrics-accounts/{metricsAccountId}
Get a specific metrics account
1 param → 200
Associated accounts 1
GET
/v1/associated-accounts
Get a list of all accounts derived from the accountId
getRelatedAccounts → 200
Who am I 1
GET
/v2/whoami
Retrieve account information
whoAmI → 200
Authentication groups 2

Before you can use Authentication Groups API, Logz.io support will need to enable [SSO](https://docs.logz.io/user-guide/users/single-sign-on/) for your account.

GET
/v1/authentication/groups
Get authentication groups
getAuthGroups → 200
POST
/v1/authentication/groups
Create/update authentication groups
setAuthGroups 1 param → 200
Manage time-based log accounts 7

Use these API requests to manage time-based log accounts: Create, update, or delete a sub account. Allocate daily capacity to the main account and/or sub accounts. Retrieve accoun…

GET
/v1/account-management/time-based-accounts
Retrieve settings for all accounts
getAll → 200
POST
/v1/account-management/time-based-accounts
Create a sub account
createTimeBasedAccount 1 param → 200
GET
/v1/account-management/time-based-accounts/{id}
Retrieve account settings by ID
get 1 param → 200
PUT
/v1/account-management/time-based-accounts/{id}
Update an account
updateTimeBasedAccount 2 params → 204
DELETE
/v1/account-management/time-based-accounts/{id}
Delete a sub account
deleteTimeBasedAccount 1 param → 204
GET
/v1/account-management/time-based-accounts/detailed
Retrieve detailed information for all accounts
getAllDetailedTimeBasedAccount → 200
GET
/v1/account-management/time-based-accounts/detailed/{id}
Retrieve detailed account information by account ID
getDetailedTimeBasedAccount 1 param → 200
Search logs 2

Use the Elasticsearch Search API DSL query language to search your Logz.io data. To ensure system performance and data availability, we've introduced some limitations to the origi…

POST
/v1/search
Search logs
search 1 param → 200
POST
/v1/scroll
Scroll logs
scroll 1 param → 200
Archive logs 6

You can archive logs to an AWS S3 bucket or Azure Blob Storage. Archiving gives you the option to restore logs and query them after they have expired from your time-based account.…

GET
/v2/archive/settings
Retrieve archiving settings
getSettingsForAccount → 200
POST
/v2/archive/settings
Set up archiving
createSettings 1 param → default
POST
/v2/archive/settings/test
Test archive settings
testSettings 1 param → default
GET
/v2/archive/settings/{id}
Retrieve archive settings
getSettings 1 param → 200
PUT
/v2/archive/settings/{id}
Update archive settings
updateSettings 2 params → default
DELETE
/v2/archive/settings/{id}
Delete archive settings
deleteSettings 1 param → default
Restore logs 4

You can restore data from your active archiving account, whether an AWS S3 bucket or Azure Blob Storage. Restoring data gives you the option to query logs after they have expired…

GET
/archive/restore
Retrieve all restore operations
getRestoreRequestsForAccountApi → 200
POST
/archive/restore
Initiate restore operation
createRestore 1 param → 200
GET
/archive/restore/{id}
Get an update on a restore operation
getRestoreRequestByIdApi 1 param → 200
DELETE
/archive/restore/{id}
Delete a restore operation
abortRestoreRequestApi 1 param → 200
Parsing 4
POST
/v1/sawmill/log-type-pipeline/{logType}
Parse sample logs with a Sawmill pipeline
getSawmillTestType 2 params → 200
GET
/v1/sawmill/log-type-pipeline/{logType}
Get pipeline definition for a log type
getLogType 1 param → 200404
POST
/v1/sawmill/external-mapping/upload
Upload an external mapping file to Logz.io storage.
postSawmillMappingFile 1 param → 201400422
GET
/v1/account/log-types
Get all log types
getLogTypes → 200
Alerts 8

Logz.io alerts use a Kibana search query to continuously scan your logs and alert you when a certain set of conditions is met. The simplest alerts can use a simple search query or…

GET
/v2/alerts
Retrieve all alerts
getAllAlerts 1 param → 200
POST
/v2/alerts
Create an alert
createAlert 1 param → 200
GET
/v2/alerts/<>
Retrieve alert by ID
getAlert 1 param → 200
PUT
/v2/alerts/<>
Update an alert
updateAlert 2 params → 200
DELETE
/v2/alerts/<>
Delete an alert
deleteAlert 1 param → 200
POST
/v2/alerts/{id}/enable
Enable alert by ID
enableAlert 1 param → default
POST
/v2/alerts/{id}/disable
Disable alert by ID
disableAlert 1 param → default
POST
/v1/alerts/triggered-alerts
Retrieve triggered alerts
TriggeredAlerts 7 params → 200
Deployments 1

Send deployment logs by API to automatically correlate exceptions with service deployments directly in your Logz.io Exceptions tab.

POST
/v2/markers/create-markers
Add deployment markers to Exception graphs
createMarkers 1 param → default
Insights 1

Logz.io monitors your logs for Insights to help you preempt issues and alert you of potential problems. There are two types of Insights: LOGCEPTION - Application errors and except…

POST
/v1/insights/list
Get the list of Insights
getPublicInsights 1 param → 200
Retrieve audit trail 2
POST
/v1/audit-trail/event-types
Retrieve all event types in the audit trail
listAccountAuditTrails → 200
POST
/v1/audit-trail
Retrieve a filtered list of audit trail events
listAccountAuditTrailsFiltered 1 param → 200
Connect to CloudTrail 5

Establish a connection to ship logs to the Logz.io observability platform via an S3 bucket. Supports CloudTrail logs.

GET
/v1/log-shipping/cloudtrails
Retrieve all connected CloudTrail resources
getAccountCloudTrails → 200
POST
/v1/log-shipping/cloudtrails
Create a new CloudTrail connector
createCloudTrail 1 param → 200
GET
/v1/log-shipping/cloudtrails/{id}
Retrieve CloudTrail connector by ID
getCloudTrail 1 param → 200
PUT
/v1/log-shipping/cloudtrails/{id}
Update a CloudTrail connector
updateCloudTrail 2 params → 200
DELETE
/v1/log-shipping/cloudtrails/{id}
Delete a CloudTrail connector
deleteCloudTrail 1 param → 200
Connect to S3 Buckets 6

Establish a connection for the Logz.io fetcher to fetch logs to the Logz.io observability platform via an S3 bucket. Supports ELB, S3 Access, CloudFront, VPC Flow logs. If you're…

GET
/v1/log-shipping/s3-buckets
Retrieve all connected S3 buckets
getS3Buckets → 200
POST
/v1/log-shipping/s3-buckets
Create a new S3 bucket connector
createBuckets 1 param → default
GET
/v1/log-shipping/s3-buckets/{id}
Retrieve an S3 bucket connector by ID
getS3Bucket 1 param → 200
PUT
/v1/log-shipping/s3-buckets/{id}
Update an S3 bucket connector
updateBucket 2 params → default
DELETE
/v1/log-shipping/s3-buckets/{id}
Delete an S3 connector
deleteBucket 1 param → default
GET
/v1/log-shipping/s3-buckets/aws-assume-role-details
Get account information for IAM Role
getAWSAssumeRoleDetails → 200
Manage notification endpoints 21

Logz.io can send notifications to your preferred workspaces, such as Opsgenie, BigPanda, PagerDuty, and Slack. Notifications are typically sent when alerts are triggered, when a u…

POST
/v1/endpoints/slack
Create a Slack endpoint
createSlack 2 params → 200
PUT
/v1/endpoints/slack/{id}
Update Slack endpoint
updateSlack 3 params → 200
POST
/v1/endpoints/custom
Create a custom notification endpoint
createCustom 2 params → 200
PUT
/v1/endpoints/custom/{id}
Update a custom notification endpoint
updateCustom 3 params → 200
POST
/v1/endpoints/pager-duty
Create a PagerDuty endpoint
createPagerDuty 2 params → 200
PUT
/v1/endpoints/pager-duty/{id}
Update a PagerDuty endpoint
updatePagerDuty 3 params → 200
POST
/v1/endpoints/big-panda
Create a BigPanda endpoint
createBigPanda 2 params → 200
PUT
/v1/endpoints/big-panda/{id}
Update a BigPanda endpoint
updateBigPanda 3 params → 200
POST
/v1/endpoints/data-dog
Create a Datadog endpoint
createDataDog 2 params → 200
PUT
/v1/endpoints/data-dog/{id}
Update a Datadog endpoint
updateDataDog 3 params → 200
POST
/v1/endpoints/victorops
Create a VictorOps endpoint
createVictorops 2 params → 200
PUT
/v1/endpoints/victorops/{id}
Update a VictorOps endpoint
updateVictorops 3 params → 200
GET
/v1/endpoints/{id}
Retrieve an endpoint by ID
getEndpointById 1 param → 200
DELETE
/v1/endpoints/{id}
Delete an endpoint
deleteEndpoint 1 param → 204
GET
/v1/endpoints
Retrieve all notification endpoints
getAllEndpoints → 200
POST
/v1/endpoints/ops-genie
Create an OpsGenie endpoint
createOpsGenie 2 params → 200
PUT
/v1/endpoints/ops-genie/{id}
Update an OpsGenie endpoint
updateOpsGenie 3 params → 200
POST
/v1/endpoints/service-now
Create an ServiceNow endpoint
createServiceNow 2 params → 200
PUT
/v1/endpoints/service-now/{id}
Update an ServiceNow endpoint
updateServiceNow 3 params → 200
POST
/v1/endpoints/microsoft-teams
Create an Microsoft Teams endpoint
createMicrosoftTeams 2 params → 200
PUT
/v1/endpoints/microsoft-teams/{id}
Update an Microsoft Teams endpoint
updateMicrosoftTeams 3 params → 200
Import or export Kibana objects 2
POST
/v1/kibana/export
Export Kibana objects
exportSavedObjects 1 param → 200
POST
/v1/kibana/import
Import Kibana objects
importSavedObjects 1 param → 200
Manage log shipping tokens 6

Use these API endpoints to create, update, retrieve, or delete log shipping tokens.

POST
/v1/log-shipping/tokens
Create a log shipping token
createNewLogShippingToken 1 param → 201
GET
/v1/log-shipping/tokens/{id}
Retrieve a log shipping token by ID
getLogShippingTokenById 1 param → 200
PUT
/v1/log-shipping/tokens/{id}
Update a log shipping token
updateLogShippingToken 2 params → 200
DELETE
/v1/log-shipping/tokens/{id}
Delete a log shipping token
deleteLogShippingToken 1 param → 200
GET
/v1/log-shipping/tokens/limits
Get number of available tokens
getLogShippingTokensLimits → 200
POST
/v1/log-shipping/tokens/search
Retrieve log shipping tokens
searchLogShippingTokens 1 param → 200
Manage shared tokens 9

You can share Kibana visualization and dashboard snapshots using shared tokens. Snapshots are stored for 30 days and automatically deleted afterwards. Token filters are available…

GET
/v1/shared-tokens/filters
Retrieve all shared token filters
getAllFilters → 200400403
POST
/v1/shared-tokens/filters
Create a shared token filter
createFilter 1 param → 200400403
GET
/v1/shared-tokens/filters/{id}
Retrieve a shared token filter by ID
getFilter 1 param → 200400403
DELETE
/v1/shared-tokens/filters/{id}
Delete a shared token filter
deleteFilter 1 param → 200400403
GET
/v1/shared-tokens/{id}
Retrieve a shared token by ID
getToken 1 param → 200400403
PUT
/v1/shared-tokens/{id}
Update a shared token
updateToken 2 params → 200400403
DELETE
/v1/shared-tokens/{id}
Delete a shared token
deleteToken 1 param → 204400403
GET
/v1/shared-tokens
Retrieve all shared tokens
getAllTokens → 200400403
POST
/v1/shared-tokens
Create a shared token
createToken 1 param → 200400403
Manage API tokens 1

You can manage API tokens for sub accounts.

POST
/v1/api-tokens/sub-account
Create a sub account API token.
CreateApiTokenRequest 1 param → 200400401403404
Logz.io snapshots 2
POST
/v1/snapshotter
Create a snapshot
createSnapshot 1 param → 200
GET
/v1/snapshotter/{snapshotId}
Retrieve a snapshot by ID
getSnapshot 1 param → 200
Manage users 11
GET
/v1/user-management/recursive
Retrieve users in all associated accounts
listAllAccountUsers → 200
GET
/v1/user-management
Retrieve all users
listUsers 1 param → 200
POST
/v1/user-management
Create a user
createUser 1 param → 200
GET
/v1/user-management/{id}
Retrieve a user by ID
getUser 1 param → 200
PUT
/v1/user-management/{id}
Update a user
updateUser 2 params → 200
DELETE
/v1/user-management/{id}
Delete a user
deleteUser 2 params → 200
DELETE
/v1/user-management/{id}/recursive
Delete a user from all accounts
deleteUserRecursively 1 param → 200
POST
/v1/user-management/suspend/{id}
Suspend a user
suspendUser 1 param → 200
POST
/v1/user-management/unsuspend/{id}
Unsuspend a user
unsuspendUser 1 param → 200
PUT
/v1/user-management/{id}/suspend/recursive
Suspend a user from all accounts
suspendUserRecursively 1 param → 200
PUT
/v1/user-management/{id}/unsuspend/recursive
Unsuspend a user from all accounts
unsuspendUserRecursively 1 param → 200
Security rules 9

Security rules help you connect the dots between your data sources and events that could indicate a security threat or breach. Your Cloud SIEM account comes pre-configured with se…

POST
/v2/security/rules
Create a security rule
createSecurityRule 1 param → 201
GET
/v2/security/rules/{ruleId}
Retrieve a security rule
getSecurityRule 1 param → 200
PUT
/v2/security/rules/{ruleId}
Update a security rule
updateSecurityRule 2 params → 200
DELETE
/v2/security/rules/{ruleId}
Delete a security rule
deleteSecurityRule 1 param → 200
POST
/v2/security/rules/search
Retrieve security rules
searchAccountSecurityRules 1 param → 200
POST
/v2/security/rules/{id}/enable
Enable a rule
enableSecurityRule 1 param → default
POST
/v2/security/rules/{id}/disable
Disable a rule
disableSecurityRule 1 param → default
POST
/v2/security/rules/bulk/update
Bulk update security rules
bulkUpdateSecurityRule 1 param → default
POST
/v2/security/rules/bulk/delete
Bulk delete security rules
bulkDeleteSecurityRule 1 param → default
Security events 3

A security event is logged whenever a security rule triggers in your [Logz.io Cloud SIEM account](https://app.logz.io//dashboard/security/rules/rule-definitions?from=0&sortBy=upda…

POST
/v2/security/rules/events/search
Fetch security events
searchSecurityRulesEvents 1 param → 200
PUT
/v2/security/rules/events/{ruleId}
Edit security events
editSecurityRulesEvents 1 param → 201403
POST
/v2/security/rules/events/logs/search
Fetch the logs that triggered a security event
searchSecurityRuleEventLogs 1 param → 200
Security account 1

A security account with SIEM allows you to use the SIEM platform. You can create a SIEM account using an API call.

POST
/v2/account-management/siem
Create SIEM account
postSIEM 1 param → 200
Drop filters 5

Drop filters provide a solution for filtering out logs before they are indexed in your account to help lower costs and reduce account volume. Drop filters evaluate logs for exact…

POST
/v1/drop-filters/search
Retrieve drop filters
getAllForAccount → 200
POST
/v1/drop-filters/{id}/activate
Activate a drop filter
activate 1 param → 200
POST
/v1/drop-filters/{id}/deactivate
Deactivate a drop filter
deactivate 1 param → 200
DELETE
/v1/drop-filters/{id}
Delete a drop filter
delete 1 param → 200
POST
/v1/drop-filters
Create drop filter
create 1 param → 200
Lookup lists 11
POST
/v1/lookup-lists
Create lookup list
createLookupList 1 param → 200
POST
/v1/lookup-lists/search
Get all/Search lookup lists
searchLookupLists 1 param → 200
GET
/v1/lookup-lists/{id}
Get lookup by ID
getLookupList 1 param → 200
PUT
/v1/lookup-lists/{id}
Update lookup list
updateLookupList 2 params → 200
DELETE
/v1/lookup-lists/{id}
Delete lookup list
deleteLookupList 1 param → 200
POST
/v1/lookup-lists/{lookupListId}/elements
Add element to a lookup list
createLookupListElement 2 params → 200
POST
/v1/lookup-lists/{lookupListId}/elements/search
Get all/Search lookup elements
searchLookupListElements 2 params → 200
GET
/v1/lookup-lists/{lookupListId}/elements/{id}
Get element
getLookupListElement 2 params → 200
PUT
/v1/lookup-lists/{lookupListId}/elements/{id}
Update element
updateLookupListElement 3 params → 200
DELETE
/v1/lookup-lists/{lookupListId}/elements/{id}
Delete element
deleteLookupListElement 2 params → 200
POST
/v1/lookup-lists/{lookupListId}/elements/bulk-add
Add elements in bulk
addLookupListElements 3 params → 200

Schemas 154

The contract defines 154 schemas that model the data the API accepts and returns. The most detailed are SecurityRuleResponse (21 properties), TimeBasedAccount (18 properties), RulesEventsEdit (17 properties), PagedEdithResponseTriggeredResponse (17 properties). Each schema is shown below with its type and property counts.

QueryResult
object
2 properties
RangeQueryResult
object
2 properties
LabelValuesResult
object
2 properties
SeriesResult
object
2 properties
LabelNamesResult
object
2 properties
PagedSearchResponseLookupListElement
object
3 properties
LookupListElement
object
4 properties
LookupListElementCreateRequest
object
3 properties 1 required
LookupList
object
3 properties
LookupListCreateRequest
object
2 properties
PagedSearchResponseLookupList
object
3 properties
LookupListsFilter
object
Filter by names that contain a term, by lookup ID, or by both. If both properties are sent, they must both be satsified (AND logic).
2 properties
LookupListsSearchRequest
object
2 properties
LookupListElementsFilter
object
Filter for elements by value, element ID, or by comments that contain a search term. If multiple properties are sent, they must all be satisfied (AND logic).
3 properties
LookupListElementsSearchRequest
object
2 properties
LookupListElementBulkResponse
object
3 properties
WhoAmIV2Response
object
2 properties
AccountUtilizationSettings
object
Settings for logging metrics on your account utilization, such as used and expected data volume at current indexing rate.
2 properties
AccountView
object
10 properties
DailyUsagesList
object
1 property
TimeBasedAccountUpdateRequest
object
11 properties 2 required
DetailedTimeBasedAccount
object
7 properties
LHDailyCount
object
2 properties
TimeBasedAccountCreateRequest
object
12 properties 4 required
SharingAccount
object
2 properties
SubAccountRelation
object
Properties of the sub accounts related to this main account
8 properties
TimeBasedAccount
object
18 properties
TimeBasedAccountCreationResponse
object
1 property
Searchable
boolean
If other accounts can search this account's logs, true. Otherwise, false.
Accessible
boolean
If users of the main account can access this account, true. Otherwise, false.
DocSizeSetting
boolean
Adds a LogSize field to each log to record the size in bytes, to better manage the account utilization.
snapsearchRetentionDays
integer
Number of days to retain data in the warm tier. Minimum value is 1.
AlertEventLogsSearchRequest
object
2 properties 1 required
RuleEventLogsFilter
object
Filter by the event's unique GUID to retrieve only the logs relevant to the event under investigation.
1 property 1 required
Pagination
object
Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination functi…
2 properties
PagedSearchResponseMapStringObject
object
3 properties
PagedSearchResponseTriggeredAlert
object
3 properties
PagedEdithResponseTriggeredResponse
array
17 properties
PagedSearchResponseTriggeredResponse
object
3 properties
TriggeredAlert
object
13 properties
TriggeredRule
object
14 properties
AlertsEventsEditRequest
object
3 properties
AlertsEventsSearchRequest
object
3 properties
RulesEventsSortRequest
object
2 properties 1 required
RulesEventsEdit
object
Edit Security rules.
17 properties
RulesEventsFilter
object
Filter by rule name, rule severity, or time range.
4 properties
RulesTimeRange
object
Add a timerange to filter by event timestamps that fall within the range. If applied, both the earliest and latest thresholds are required.
2 properties 2 required
PagedSearchResponseSecurityRuleResponse
object
3 properties
AlertsSearchRequest
object
3 properties
AlertsSortRequest
object
2 properties 1 required
AlertsFilter
object
7 properties
CreateMarkersRequest
object
1 property
MarkerDataPoint
object
7 properties 2 required
PublicGetAccountInsightsRequest
object
11 properties
PageResponsePublicAccountInsightResponse
object
4 properties
PublicAccountInsightResponse
object
12 properties
AuditTrailEventTypesResponse
object
1 property
AuditEventData
object
7 properties
AuditEventExtraData
object
3 properties
AuditEventTypeData
object
2 properties
AuditEventUser
object
4 properties
AuditTrailFilteredResponse
object
6 properties
AuditTrailFilterRequest
object
8 properties
CloudTrailResponse
object
5 properties
IdBean
object
1 property
CloudTrailRequest
object
5 properties
MessageBean
object
1 property
S3BucketRequest
object
9 properties 3 required
S3BucketResponse
object
9 properties 3 required
AWSAssumeRoleDetails
object
2 properties
EndpointUpsertResponse
object
1 property
SlackEndpointUpsertRequest
object
3 properties
CustomEndpointUpsertRequest
object
6 properties
PagerDutyEndpointUpsertRequest
object
3 properties
BigPandaEndpointUpsertRequest
object
4 properties
DatadogEndpointUpsertRequest
object
3 properties
VictoropsEndpointUpsertRequest
object
5 properties 3 required
Endpoint
object
4 properties
OpsGenieEndpointUpsertRequest
object
3 properties
ServiceNowEndpointUpsertRequest
object
5 properties
MicrosoftTeamsEndpointUpsertRequest
object
3 properties
KibanaExportResponse
object
2 properties
KibanaExportRequest
object
1 property 1 required
KibanaImportResponse
object
4 properties
KibanaImportRequest
object
3 properties
ScrollResponse
object
3 properties
ScrollRequest
object
8 properties
QueryFilter
object
4 properties 2 required
SharedToken
object
7 properties
CreateSharedTokenRequest
object
3 properties
UpdateSharedTokenRequest
object
2 properties 1 required
ApiTokenResponse
object
4 properties
CreateApiTokenRequest
object
2 properties
SnapshotCreateResponse
object
1 property
SnapshotCreateRequest
object
11 properties 5 required
SnapshotGetResponse
object
11 properties
SnapshotNotification
object
4 properties
SnapshotRequest
object
10 properties
User
object
6 properties
UserManagementUpsertResponse
object
1 property
UserManagementUpsertRequest
object
4 properties 4 required
DropFiltersCreateRequest
object
4 properties 1 required
FieldCondition
object
2 properties
LogsDropFiltersPipelineDefinition
object
6 properties
ArchiveSettings
object
5 properties 1 required
ArchiveSettingsResponse
object
2 properties
BlobSettings
object
Applicable settings when the storageType is Blob. For detailed instructions about setting up a storage container in Azure and locating the required parameters,…
6 properties 5 required
S3IamCredentials
object
1 property
S3SecretCredentials
object
Authentication with S3 Secret Credentials is supported for backward compatibility. IAM roles are strongly recommended.
2 properties 2 required
S3StorageSettings
object
Applicable settings when the storageType is S3.
4 properties 2 required
TestStorageRequest
object
ShippingTokensModel
object
8 properties
ShippingTokensRequest
object
2 properties
ShippingTokensLimitsResponse
object
2 properties
ShippingTokensSearchRequest
object
3 properties
ShippingTokensSortRequest
object
2 properties
ShippingTokensFilterRequest
object
Filters your search for token attributes.
1 property 1 required
PagedSearchResponseShippingTokensModel
object
3 properties
Aggregation
object
Specifies a trigger condition that acts as a threshold.
3 properties
AlertV2Response
object
15 properties
AlertOutput
object
Automatically sends out notifications with sample results when the alert triggers.
3 properties
AlertQuery
object
Determines when the alert should trigger using any combination of a search query, filters, group by aggregations, accounts to search, and trigger conditions.
6 properties
TriggeredAlertsResponse
object
4 properties
AlertRecipients
object
Add email addresses and/or endpoint channels to automatically receive notifications with sample data when the alert triggers.
2 properties
AlertSchedule
object
Defines the frequency and the time frame in which an alert will be evaluated.
2 properties
SubAlert
object
3 properties
SubAlertCorrelation
object
Only applicable when multiple sub-components are in use. Selects a logic for correlating the alert’s sub-components. AND is currently the only supported operat…
2 properties
SubAlertOutput
object
Selects the data output to be sent in the notification when the alert triggers. Not applicable, when grouping by fields or aggregating results, as the output i…
2 properties
AlertV2Request
object
10 properties 2 required
AlertTrigger
object
Sets the triggering threshold and severity tab to label the event when the alert triggers.
2 properties
SilenceGetAll
object
8 properties 2 required
SilenceCreate
object
5 properties
BoolFilter
object
Apply must and mustnot filters to the monitoring alert. Filters are more efficient compared to a query, so it's recommended to opt for a filter over a query, w…
1 property
ColumnConfig
object
Customize the alert output to be sent out in notifications when the alert triggers.
3 properties
FilterLists
object
Runs Elasticsearch [Bool Query](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/query-dsl-bool-query.html) filters on the data (before the search q…
2 properties
PagedSearchResponseString
object
3 properties
TagsFilter
object
1 property
TagsSearchRequest
object
2 properties
RuleOutput
object
Automatically sends out notifications with sample results when the rule triggers.
3 properties
RuleQuery
object
Determines when the rule should trigger using any combination of a search query, filters, group by aggregations, accounts to search, and trigger conditions.
6 properties
RuleRecipients
object
Add email addresses and/or endpoint channels to automatically receive notifications with sample data when the rule triggers.
2 properties
SubRule
object
3 properties
SubRuleCorrelation
object
Only applicable when multiple sub-components are in use. Selects a logic for correlating the rule’s sub-components. AND is currently the only supported operato…
2 properties
SubRuleOutput
object
Selects the data output to be sent in the notification when the rule triggers. Not applicable, when grouping by fields or aggregating results, as the output is…
3 properties
RuleSchedule
object
Defines the frequency and the time frame in which an rule will be evaluated.
2 properties
SecurityRuleRequest
object
15 properties 1 required
RuleTrigger
object
Sets the triggering threshold and severity tab to label the event when the rule triggers.
2 properties
RuleColumnConfig
object
Customize the rule output to be sent out in notifications when the rule triggers.
3 properties
SecurityRuleResponse
object
21 properties
RestoreAccountConfiguration
object
6 properties
RestoreApiResponse
object
11 properties
RestoreApiRequest
object
3 properties
RestoreRequest
object
4 properties
AccountViewV3
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

logz-io-api-openapi.yml Raw ↑

Other APIs Logz.io publishes across the network.

Logz.io Search Logs API
AE Profile APIs.io
Logz.io Archive and Restore API
AE Profile APIs.io
Logz.io Drop Filters API
AE Profile APIs.io
Logz.io Alerts API
AE Profile APIs.io
Logz.io Notification Endpoints API
AE Profile APIs.io
Logz.io Tokens API
AE Profile APIs.io
Logz.io Accounts API
AE Profile APIs.io
Logz.io Metrics Prometheus API
AE Profile APIs.io
Logz.io Grafana API
AE Profile APIs.io
Logz.io Perses API
AE Profile APIs.io
Logz.io Cloud SIEM API
AE Profile APIs.io
Logz.io Log Shipping API
AE Profile APIs.io
#Account Management#User#Identity
← Back to L APIs
API Details
ID
logz-io:logz-io-users-api
Base URL
https://api.logz.io/v1/user-management
Docs
https://api-docs.logz.io/docs/logz/manage-users/
Provider
Logz.io
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=logz-io-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/logz-io-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Logz.io Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.