{ "opencollection": "1.0.0", "info": { "name": "openobserve Actions Organizations API", "version": "0.90.0" }, "items": [ { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Get user's organizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of all organizations that the authenticated user has access to, including organization details, permissions, and subscription information. Root users can see all organizations in the system." }, { "info": { "name": "Create new organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new organization with the specified configuration and settings. The authenticated user will be automatically added as an owner of the newly created organization and can then invite other users and configure the organization. If the creator is a service account, the response will include the service account's token for the newly created organization, enabling automated workflows to immediately access the new organization without additional token retrieval steps." }, { "info": { "name": "Assume a service account in a target organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/organizations/assume_service_account", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name (must be _meta)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This endpoint allows meta service accounts to obtain temporary session tokens\nfor accessing a target organization as a specific service account. The session\nautomatically expires after the specified duration.\n\n# Security\n- Only meta service accounts can call this endpoint\n- The service account must exist in both _meta and target organization\n- The service account must have the appropriate role in the target organization\n- Maximum session duration is capped at 24 hours\n\n# Example\n```bash\ncurl -X " }, { "info": { "name": "Get user's ingestion token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/passcode", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the current ingestion token (passcode) for the authenticated user within the specified organization. This token is used to authenticate data ingestion requests and can be used with various ingestion endpoints." }, { "info": { "name": "Update user's ingestion token", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/:org_id/passcode", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generates a new ingestion token (passcode) for the authenticated user within the specified organization. The old token will be invalidated and all ingestion processes using the old token will need to be updated with the new token." }, { "info": { "name": "Rename organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/:org_id/rename", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Changes the display name of an organization. The organization identifier remains unchanged, but the human-readable name is updated. This helps with organization management and branding without affecting API integrations or data access." }, { "info": { "name": "Get user's RUM ingestion token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/rumtoken", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the current Real User Monitoring (RUM) ingestion token for the authenticated user within the specified organization. This token is specifically used for ingesting RUM data from web applications and mobile apps." }, { "info": { "name": "Create user's RUM ingestion token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/rumtoken", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new Real User Monitoring (RUM) ingestion token for the authenticated user within the specified organization. This endpoint is used when no RUM token exists yet and you need to generate the initial token for RUM data collection." }, { "info": { "name": "Update user's RUM ingestion token", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/:org_id/rumtoken", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generates a new Real User Monitoring (RUM) ingestion token for the authenticated user within the specified organization. The old RUM token will be invalidated and all RUM data collection processes using the old token will need to be updated." }, { "info": { "name": "Get organization settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/settings", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the current configuration settings for an organization, including scrape intervals, field mappings, ingestion preferences, and streaming options. Returns default settings if none have been configured previously for the organization." }, { "info": { "name": "Update organization settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/settings", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates or updates organization-specific settings such as scrape interval, trace field names, ingestion toggles, and streaming configurations. Allows administrators to customize organizational behavior and operational parameters to match specific requirements and use cases." }, { "info": { "name": "List all resolved system settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/settings/v2", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "user_id", "value": "", "type": "query", "description": "User ID for user-level resolution" }, { "name": "category", "value": "", "type": "query", "description": "Filter by setting category" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists all settings with multi-level resolution applied. Merges system, org, and user levels, returning the most specific value for each key." }, { "info": { "name": "Set organization-level setting", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/settings/v2", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates or updates an organization-level setting. This setting applies to all users in the organization unless overridden at the user level." }, { "info": { "name": "Set user-level setting", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/settings/v2/user/:user_id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "user_id", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates or updates a user-level setting. This setting applies only to the specific user and overrides org-level and system-level settings." }, { "info": { "name": "Delete user-level setting", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/:org_id/settings/v2/user/:user_id/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "user_id", "value": "", "type": "path", "description": "User ID" }, { "name": "key", "value": "", "type": "path", "description": "Setting key" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a user-level setting. After deletion, queries for this key will fall back to org-level or system-level settings." }, { "info": { "name": "Get resolved system setting", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/settings/v2/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "key", "value": "", "type": "path", "description": "Setting key" }, { "name": "user_id", "value": "", "type": "query", "description": "User ID for user-level resolution" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a setting value with multi-level resolution. Checks user-level first, then org-level, then system-level defaults. Returns the most specific setting found, or null if no setting exists at any level." }, { "info": { "name": "Delete organization-level setting", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/:org_id/settings/v2/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "key", "value": "", "type": "path", "description": "Setting key" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes an organization-level setting. After deletion, queries for this key will fall back to system-level defaults." }, { "info": { "name": "Get organization summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/summary", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves comprehensive summary statistics and information about an organization including data ingestion metrics, storage usage, stream counts, and other key performance indicators useful for monitoring organization health and usage." } ] } ], "bundled": true }