{"id":16343311,"url":"https://github.com/mikaelfangel/logpoint_api","last_synced_at":"2025-08-18T19:37:17.841Z","repository":{"id":237326851,"uuid":"791449820","full_name":"MikaelFangel/logpoint_api","owner":"MikaelFangel","description":"🪵 Elixir library that implements the Logpoint API reference","archived":false,"fork":false,"pushed_at":"2025-03-11T05:16:38.000Z","size":200,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-15T23:48:05.016Z","etag":null,"topics":["api","api-client","elixir","logpoint"],"latest_commit_sha":null,"homepage":"https://mikaelfangel.github.io/logpoint_api/api-reference.html","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MikaelFangel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"MikaelFangel"}},"created_at":"2024-04-24T18:33:05.000Z","updated_at":"2025-03-11T05:15:48.000Z","dependencies_parsed_at":"2024-06-04T06:36:13.004Z","dependency_job_id":"3ef21ae9-b2c1-4bb7-924b-3850ebf7f255","html_url":"https://github.com/MikaelFangel/logpoint_api","commit_stats":null,"previous_names":["mikaelfangel/logpoint_api"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikaelFangel%2Flogpoint_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikaelFangel%2Flogpoint_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikaelFangel%2Flogpoint_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikaelFangel%2Flogpoint_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikaelFangel","download_url":"https://codeload.github.com/MikaelFangel/logpoint_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244257259,"owners_count":20424127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","elixir","logpoint"],"created_at":"2024-10-11T00:24:07.678Z","updated_at":"2025-03-23T00:32:37.425Z","avatar_url":"https://github.com/MikaelFangel.png","language":"Elixir","funding_links":["https://github.com/sponsors/MikaelFangel"],"categories":[],"sub_categories":[],"readme":"# LogpointApi\n\nElixir library implementing the [Logpoint API reference](https://docs.logpoint.com/docs/logpoint-api-reference/en/latest/index.html).\n\n## Installation\n\n```elixir\ndef deps do\n  [\n    {:logpoint_api, github: \"MikaelFangel/logpoint_api\", tag: \"v0.2.3\"}\n  ]\nend\n```\n\n## Example Usage\n\nExamples on how to use the library where all examples assumes the following variables are set:\n\n```elixir\nip = \"127.0.0.1\"\n\ncreds = %LogpointApi.Credential{\n  username: \"admin\",\n  secret_key: \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\n}\n```\n\nIt's expected that you have included this repo into your mix project (see installation). Furthermore, module definitions, docs, and so forth have been excluded from the examples for brevity.\n\n### Run Search\n\nThis will create a search_id and then retrieve and return the result.\n\n```elixir\nquery = LogpointApi.SearchApi.Query{\n  query: \"user=*\",\n  limit: 100,\n  repos: [\"127.0.0.1:5504\"],\n  time_range [1_714_986_600, 1_715_031_000]\n}\n\nLogpointApi.run_search(ip, creds, query)\n```\n\n### Get a Search ID\n\nThis will create the search and return its id if successfull.\n\n```elixir\nquery = LogpointApi.SearchApi.Query{\n  query: \"user=*\",\n  limit: 100,\n  repos: [\"127.0.0.1:5504\"],\n  time_range [1_714_986_600, 1_715_031_000]\n}\n\nLogpointApi.IncidentApi.get_search_id(ip, creds, query)\n```\n\n### Retrieve a Search from a Search ID\n\nThis will retrieve the result of a given search ID. Be aware if the _final_ key in the result map is `false` the search hasn't completed yet, and you need to fetch again. Otherwise, if the key _success_ is `false` you need to recreate the search and try to retrieve it again.\n\n```elixir\nLogpointApi.IncidentApi.get_search_result(ip, creds, \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAA\")\n```\n\n## Contributing\nPlease refer to [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikaelfangel%2Flogpoint_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikaelfangel%2Flogpoint_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikaelfangel%2Flogpoint_api/lists"}