### Schema: AlertsV1Time Source: https://cloud.ibm.com/apidocs/logs-service-api.json Start time ```markdown ## Schema: AlertsV1Time Start time **Type:** object - **hours** (integer (int32)): Hours of the day (example: 22) - **minutes** (integer (int32)): Minutes of the hour (example: 22) - **seconds** (integer (int32)): Seconds of the minute (example: 22) ``` -------------------------------- ### GET /v1/enrichments Source: https://cloud.ibm.com/apidocs/logs-service-api.json List all enrichments ```markdown ### Responses #### 200 - OK **EnrichmentCollection** - **enrichments** (array (Enrichment)) (required): The enrichments Array items: - **id** (integer (int64)) (required): The enrichment ID (example: 1) - **field_name** (string) (required): The enrichment field name (example: "sourceIPs") - **enrichment_type** (object) (required) - **geo_ip** (object): The geo IP enrichment #### 400 - Bad Request **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 401 - Unauthorized **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 403 - Forbidden **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 404 - Not Found **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 408 - Unknown **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 409 - Conflict **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 429 - Too many requests **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 500 - Internal server error **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) ### Example Usage ```bash curl -X GET "https://api.example.com/v1/enrichments" ``` ``` -------------------------------- ### Schema: Get list of extensions response Source: https://cloud.ibm.com/apidocs/logs-service-api.json Response for getting all Extensions. ```markdown ## Schema: Get list of extensions response Response for getting all Extensions. **Type:** object - **extensions** (array (Extension)): List of Extensions. (example: []) Array items: - **id** (string) (required): The ID of the Extension. - **name** (string) (required): The name of the Extension. - **revisions** (array (ExtensionsV1ExtensionRevision)): The list of all revisions of the Extension, each representing a versioned snapshot of the Extension's functionality and appearance. (example: []) Array items: - **version** (string) (required): The version identifier for this revision of the Extension. - **description** (string): The detailed description of what this revision includes, changes made, and any important information users should be aware of. - **excerpt** (string): The brief summary or excerpt of the Extension's description for quick reference. - **labels** (array (string)): The list of labels or tags associated with the Extension for front-end categorization and filtering. (example: []) - **items** (array (ExtensionsV1ExtensionItem)): The Extension items included in this revision. (example: []) Array items: - **id** (string) (required): The ID of the Extension item. - **name** (string) (required): The name of the Extension item. - **description** (string): The detailed description of the Extension item. - **target_domain** (string (alert_definition|alert|enrichment|rule_group|view|dashboard|events_to_metrics)) (required): The domain of the Extension item. (example: "alert_definition") ("alert_definition"|"alert"|"enrichment"|"rule_group"|"view"|"dashboard"|"events_to_metrics") - **is_mandatory** (boolean): A flag to indicate if the Extension item is mandatory or not. Mandatory items must be specified when deploying the Extension. (example: false) - **keywords** (array (string)): The list of keywords to enhance search capabilities on the front-end side. (example: []) - **changelog** (array (ExtensionsV1ChangelogEntry)): The of changelog entries made in each version of the Extension. (example: []) Array items: - **version** (string) (required): The version of the Extension this changelog entry refers to. - **description_md** (string) (required): The description of the changes made in this version, formatted in Markdown for rich text presentation. - **deployment** (object): Deployment details of an Extension scoped by extension ID in the path. (example: {"version":"1.0.0","item_ids":["b9a5500c-715e-4ead-9bbe-56fdefffbfcd","17bf6c1d-7869-48ba-9c46-96721d5e2603","2d38545a-417c-4143-acb9-02c721d6312d","a686e964-c0dc-453a-a124-508f91883d0d","4082355b-5e40-4964-8578-52eb0e2e4037","66aa7da8-d36e-49ee-b357-3424a1d4c3de"],"applications":["ltest_0401"],"subsystems":["ltest_0401"]}) - **version** (string) (required): The version of the Extension revision to deploy. - **item_ids** (array (string)) (required): The list of Extension item IDs to deploy. (example: ["b9a5500c-715e-4ead-9bbe-56fdefffbfcd"]) - **applications** (array (string)): Applications that the Extension is deployed for. When this is empty, it is applied to all applications. (example: ["ltest_0401"]) - **subsystems** (array (string)): Subsystems that the Extension is deployed. When this is empty, it is applied to all subsystems. (example: ["ltest_0401"]) - **deprecation** (object): Deprecation details of the Extension. - **reason** (string) (required): The reason why the element (e.g., an Extension or a version of it) is being deprecated. - **replacement_extensions** (array (string)): The list of Extension IDs that serve as replacements for the deprecated element. (example: []) ``` -------------------------------- ### GET /v1/view_folders Source: https://cloud.ibm.com/apidocs/logs-service-api.json List view's folders ```markdown ### Responses #### 200 - OK **ViewFolderCollection** - **view_folders** (array (ViewFolder)): List of view folders Array items: - **id** (string (uuid)): Folder ID (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **name** (string) (required): Folder name (example: "My Folder") #### 400 - Bad Request **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 401 - Unauthorized **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 403 - Forbidden **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 404 - Not Found **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 408 - Unknown **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 409 - Conflict **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 429 - Too many requests **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 500 - Internal server error **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) ### Example Usage ```bash curl -X GET "https://api.example.com/v1/view_folders" ``` ``` -------------------------------- ### GET /v1/views Source: https://cloud.ibm.com/apidocs/logs-service-api.json Lists all company public views ```markdown ### Responses #### 200 - OK **ViewCollection** - **views** (array (View)): List of views Array items: - **id** (integer (int32)) (required): View ID (example: 52) - **name** (string) (required): View name (example: "Logs view") - **search_query** (object): View search query - **query** (string) (required): View search query (example: "error") - **syntax_type** (string (lucene|dataprime)): Syntax type for the query used in views. (example: "dataprime") ("lucene"|"dataprime") - **time_selection** (object) (required) - **quick_selection** (object): Quick time selection - **caption** (string) (required): Quick time selection caption (example: "Last hour") - **seconds** (integer (int64)) (required): Quick time selection amount in seconds (example: 3600) - **filters** (object): View selected filters - **filters** (array (ApisViewsV1Filter)): Selected filters Array items: - **name** (string) (required): Filter name (example: "applicationName") - **selected_values** (object): Filter selected values (example: {"cs-rest-test1":true,"demo":true}) - **folder_id** (string (uuid)): View folder ID (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **tier** (string (priority_insights|priority_insights_templates|all_logs|all_logs_templates)): Type of view (example: "archive_templates") ("priority_insights"|"priority_insights_templates"|"all_logs"|"all_logs_templates") #### 400 - Bad Request **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 401 - Unauthorized **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 403 - Forbidden **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 404 - Not Found **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 408 - Unknown **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 409 - Conflict **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 429 - Too many requests **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 500 - Internal server error **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) ### Example Usage ```bash curl -X GET "https://api.example.com/v1/views" ``` ``` -------------------------------- ### Schema: ApisAlertDefinitionTimeOfDay Source: https://cloud.ibm.com/apidocs/logs-service-api.json Start time of the alert activity ```markdown ## Schema: ApisAlertDefinitionTimeOfDay Start time of the alert activity **Type:** object - **hours** (integer (int32)): The hour of the day in 24-hour format. Must be an integer between 0 and 23. (example: 14) - **minutes** (integer (int32)): Minute of the hour of the day. Must be an integer between 0 and 59. (example: 30) ``` -------------------------------- ### POST /v1/view_folders Source: https://cloud.ibm.com/apidocs/logs-service-api.json Create view folder ```markdown ### Request Body **Content-Type:** application/json - **name** (string) (required): View folder name (example: "My folder") ### Responses #### 201 - Created **ViewFolder** - **id** (string (uuid)): Folder ID (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **name** (string) (required): Folder name (example: "My Folder") #### 400 - Bad Request **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 401 - Unauthorized **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 403 - Forbidden **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 404 - Not Found **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 408 - Unknown **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 409 - Conflict **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 429 - Too many requests **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) #### 500 - Internal server error **ApiError** - **errors** (array (OpenapiV1ApiErrorError)) (required): List of errors Array items: - **code** (string (bad_request_or_unspecified|unauthorized|forbidden|not_found|method_internal_error|conflict|unauthenticated|resource_exhausted|deadline_exceeded)) (required): Error code (example: "deadline_exceeded") ("bad_request_or_unspecified"|"unauthorized"|"forbidden"|"not_found"|"method_internal_error"|"conflict"|"unauthenticated"|"resource_exhausted"|"deadline_exceeded") - **message** (string): Human-readable error message (example: "Not found") - **more_info** (string): Additional information about the error (example: "View not found") - **trace** (string (uuid)) (required): UUID uniquely identifying the request (example: "3dc02998-0b50-4ea8-b68a-4779d716fa1f") - **status_code** (integer (int32)): HTTP status code associated with the error (example: 404) ### Example Usage ```bash curl -X POST "https://api.example.com/v1/view_folders" \ -H "Content-Type: application/json" \ -d '{ "name": "My Folder" }' ``` ```