{"id":32572361,"url":"https://github.com/alertlogic/alertlogic-sdk-definitions","last_synced_at":"2026-01-29T14:15:29.034Z","repository":{"id":38094443,"uuid":"272429841","full_name":"alertlogic/alertlogic-sdk-definitions","owner":"alertlogic","description":"Alert Logic APIs definitions","archived":false,"fork":false,"pushed_at":"2025-12-29T12:07:44.000Z","size":1809,"stargazers_count":3,"open_issues_count":195,"forks_count":14,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-12-29T18:30:20.261Z","etag":null,"topics":["sdk","yaml"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/alertlogic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-15T12:14:56.000Z","updated_at":"2025-11-21T12:09:01.000Z","dependencies_parsed_at":"2022-08-08T23:00:59.227Z","dependency_job_id":"7ad414de-70b5-4003-8382-e83bfafa257b","html_url":"https://github.com/alertlogic/alertlogic-sdk-definitions","commit_stats":{"total_commits":339,"total_committers":14,"mean_commits":"24.214285714285715","dds":"0.27728613569321536","last_synced_commit":"3c395922fbc708a9ce0e3062e256841cc9f45f8d"},"previous_names":[],"tags_count":262,"template":false,"template_full_name":null,"purl":"pkg:github/alertlogic/alertlogic-sdk-definitions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertlogic%2Falertlogic-sdk-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertlogic%2Falertlogic-sdk-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertlogic%2Falertlogic-sdk-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertlogic%2Falertlogic-sdk-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alertlogic","download_url":"https://codeload.github.com/alertlogic/alertlogic-sdk-definitions/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertlogic%2Falertlogic-sdk-definitions/sbom","scorecard":{"id":179400,"data":{"date":"2025-08-11","repo":{"name":"github.com/alertlogic/alertlogic-sdk-definitions","commit":"952183421a9e798a1cdab98b7cb0c126dd8b7901"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/24 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/stage1_merge_automatic_prs.yml:1","Warn: no topLevel permission defined: .github/workflows/stage2_create_automatic_rel_tag.yml:1","Warn: no topLevel permission defined: .github/workflows/stage3_release_pypi.yml:1","Warn: no topLevel permission defined: .github/workflows/stage4_release_gh_release.yml:1","Warn: no topLevel permission defined: .github/workflows/test_all.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage1_merge_automatic_prs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage2_create_automatic_rel_tag.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage2_create_automatic_rel_tag.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage2_create_automatic_rel_tag.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage2_create_automatic_rel_tag.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage3_release_pypi.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage3_release_pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage3_release_pypi.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage3_release_pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage3_release_pypi.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage3_release_pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage3_release_pypi.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage3_release_pypi.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage4_release_gh_release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage4_release_gh_release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage4_release_gh_release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage4_release_gh_release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stage4_release_gh_release.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/stage4_release_gh_release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test_all.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/test_all.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test_all.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/alertlogic/alertlogic-sdk-definitions/test_all.yml/master?enable=pin","Warn: pipCommand not pinned by hash: scripts/validate_my_definition.sh:25","Warn: pipCommand not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:28","Warn: pipCommand not pinned by hash: .github/workflows/stage1_merge_automatic_prs.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/stage2_create_automatic_rel_tag.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/stage2_create_automatic_rel_tag.yml:24","Warn: pipCommand not pinned by hash: .github/workflows/stage3_release_pypi.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/stage3_release_pypi.yml:28","Warn: pipCommand not pinned by hash: .github/workflows/stage3_release_pypi.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/stage3_release_pypi.yml:45","Warn: pipCommand not pinned by hash: .github/workflows/stage3_release_pypi.yml:46","Warn: pipCommand not pinned by hash: .github/workflows/test_all.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/test_all.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/test_all.yml:31","Info:   0 out of  15 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of  14 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.1.164 not signed: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/221813937","Warn: release artifact v0.1.163 not signed: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/217964890","Warn: release artifact v0.1.162 not signed: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/217308602","Warn: release artifact v0.1.161 not signed: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/207142058","Warn: release artifact v0.1.160 not signed: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/206531835","Warn: release artifact v0.1.164 does not have provenance: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/221813937","Warn: release artifact v0.1.163 does not have provenance: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/217964890","Warn: release artifact v0.1.162 does not have provenance: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/217308602","Warn: release artifact v0.1.161 does not have provenance: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/207142058","Warn: release artifact v0.1.160 does not have provenance: https://api.github.com/repos/alertlogic/alertlogic-sdk-definitions/releases/206531835"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T18:30:54.306Z","repository_id":38094443,"created_at":"2025-08-16T18:30:54.306Z","updated_at":"2025-08-16T18:30:54.306Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28879177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T10:31:27.438Z","status":"ssl_error","status_checked_at":"2026-01-29T10:31:01.017Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["sdk","yaml"],"created_at":"2025-10-29T09:36:18.876Z","updated_at":"2026-01-29T14:15:29.021Z","avatar_url":"https://github.com/alertlogic.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Alert Logic APIs definitions\n\n[![Build Status](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions.svg?branch=master)](https://travis-ci.com/alertlogic/alertlogic-sdk-definitions)\n[![PyPI version](https://badge.fury.io/py/alertlogic-sdk-definitions.svg)](https://badge.fury.io/py/alertlogic-sdk-definitions)\n\nRepository contains static definitions of Alert Logic APIs, used for documentation generation, \n[SDK](https://github.com/alertlogic/alertlogic-sdk-python) and [CLI](https://github.com/alertlogic/alcli).\n\n### Usage\n\n#### Install \n`pip install alertlogic-sdk-definitions`\n\nFor the one who doesn't require python code, GitHub releases are produced \ncontaining an archive with OpenAPI definitions only, see\n[here](https://github.com/alertlogic/alertlogic-sdk-definitions/releases)\n\n#### Test\n`python -m unittest`\n\n#### Use\n\nList available service definitions:\n```\n\u003e\u003e\u003e import alsdkdefs\n\u003e\u003e\u003e alsdkdefs.list_services()\nOrderedDict([('aecontent', ServiceDefinition(aecontent)), ('aefr', ServiceDefinition(aefr)), ('aepublish', ServiceDefinition(aepublish)), ('aerta', ServiceDefinition(aerta)), ('aetag', ServiceDefinition(aetag)), ('aetuner', ServiceDefinition(aetuner)), ('aims', ServiceDefinition(aims)), ('assets_query', ServiceDefinition(assets_query)), ('assets_write', ServiceDefinition(assets_write)), ('connectors', ServiceDefinition(connectors)), ('credentials', ServiceDefinition(credentials)), ('deployments', ServiceDefinition(deployments)), ('herald', ServiceDefinition(herald)), ('ingest', ServiceDefinition(ingest)), ('iris', ServiceDefinition(iris)), ('kalm', ServiceDefinition(kalm)), ('notify', ServiceDefinition(notify)), ('otis', ServiceDefinition(otis)), ('policies', ServiceDefinition(policies)), ('remediations', ServiceDefinition(remediations)), ('responder', ServiceDefinition(responder)), ('search', ServiceDefinition(search)), ('subscriptions', ServiceDefinition(subscriptions)), ('themis', ServiceDefinition(themis))])\n```\n\nGet path to a service definitions paths:\n```\n\u003e\u003e\u003e import alsdkdefs\n\u003e\u003e\u003e alsdkdefs.get_service_defs(\"aerta\")\n['/usr/local/lib/python3.8/site-packages/alsdkdefs/apis/aerta/aerta.v1.yaml']\n```\n\nGet normalised service spec of a service(all refs resolved, \n                                 path parameters moved to the methods, \n                                 allOfs are merged if possible):\n```\n\u003e\u003e\u003e import alsdkdefs\n\u003e\u003e\u003e alsdkdefs.load_service_spec(\"aerta\")\n```\n\nValidate service spec: \n```\n\u003e\u003e\u003e import alsdkdefs\n\u003e\u003e\u003e service_spec = alsdkdefs.load_service_spec(\"aerta\")\n\u003e\u003e\u003e alsdkdefs.validate(service_spec)\n```\n\n#### Quick validation of a definition\n\nWhile YAML definition is developed apart from the current package and current repo,\nit is required to validate it prior to push, please add this to your `Makefile` \nin order to achieve quick validation:\n\n`curl -s https://raw.githubusercontent.com/alertlogic/alertlogic-sdk-definitions/master/scripts/validate_my_definition.sh | bash -s \u003cpath/to/definitions/directory\u003e`\n\nIf no directory is specified, by default `doc/openapi/` directory will be used, if such behaviour is desired, use following line instead:\n\n`curl -s https://raw.githubusercontent.com/alertlogic/alertlogic-sdk-definitions/master/scripts/validate_my_definition.sh | bash `\n\nIt is recommended to invoke it via curl, since validation of the definitions might be extended with time.\nScript requires `python3` to be available in the system.\n\nValidation checks:\n* YAML of a definition is valid\n* Definition passes OpenAPI 3 schema validation\n\n### Development\n\nPlease submit a PR. Please note that API definitions are updated automatically and any changes to it will be overwritten, see:\n[automatic update process](doc/automatic_releases.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertlogic%2Falertlogic-sdk-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falertlogic%2Falertlogic-sdk-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertlogic%2Falertlogic-sdk-definitions/lists"}