{"id":36454546,"url":"https://github.com/tphakala/go-xsoar","last_synced_at":"2026-01-11T23:01:39.030Z","repository":{"id":329139593,"uuid":"1118271665","full_name":"tphakala/go-xsoar","owner":"tphakala","description":"Native Go API client for Palo Alto Networks Cortex XSOAR 8.x / XSIAM","archived":false,"fork":false,"pushed_at":"2025-12-17T15:07:15.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-21T03:05:09.031Z","etag":null,"topics":["api-client","cortex","cortex-xsoar","go","golang","palo-alto","palo-alto-networks","paloaltonetworks","security","siem","soar","xsiam","xsoar"],"latest_commit_sha":null,"homepage":"","language":"Go","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/tphakala.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":"2025-12-17T14:05:35.000Z","updated_at":"2025-12-17T15:05:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/tphakala/go-xsoar","commit_stats":null,"previous_names":["tphakala/go-xsoar"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/tphakala/go-xsoar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tphakala%2Fgo-xsoar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tphakala%2Fgo-xsoar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tphakala%2Fgo-xsoar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tphakala%2Fgo-xsoar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tphakala","download_url":"https://codeload.github.com/tphakala/go-xsoar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tphakala%2Fgo-xsoar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28326166,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T22:11:01.104Z","status":"ssl_error","status_checked_at":"2026-01-11T22:10:58.990Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["api-client","cortex","cortex-xsoar","go","golang","palo-alto","palo-alto-networks","paloaltonetworks","security","siem","soar","xsiam","xsoar"],"created_at":"2026-01-11T23:01:38.932Z","updated_at":"2026-01-11T23:01:39.004Z","avatar_url":"https://github.com/tphakala.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# go-xsoar\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/tphakala/go-xsoar.svg)](https://pkg.go.dev/github.com/tphakala/go-xsoar)\n[![CI](https://github.com/tphakala/go-xsoar/actions/workflows/ci.yaml/badge.svg)](https://github.com/tphakala/go-xsoar/actions/workflows/ci.yaml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/tphakala/go-xsoar)](https://goreportcard.com/report/github.com/tphakala/go-xsoar)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nNative Go API client for Palo Alto Networks Cortex XSOAR 8.x / XSIAM.\n\n## Features\n\n- **Modern Go** - Requires Go 1.24+, uses `iter.Seq2` iterators for pagination\n- **Type-safe** - Strongly typed models with `errors.As()` support for error handling\n- **Service-based** - Clean API surface: `client.Incidents.Search()`, `client.Incidents.Get()`\n- **Flexible** - Functional options pattern for configuration\n- **Testable** - Interfaces with mockery support, injectable HTTP client\n\n## Installation\n\n```bash\ngo get github.com/tphakala/go-xsoar\n```\n\n## Quick Start\n\n```go\npackage main\n\nimport (\n    \"context\"\n    \"fmt\"\n    \"log\"\n\n    \"github.com/tphakala/go-xsoar\"\n)\n\nfunc main() {\n    // Create client\n    client, err := xsoar.NewClient(\n        xsoar.WithBaseURL(\"https://api-tenant.xdr.us.paloaltonetworks.com\"),\n        xsoar.WithAPIKey(\"your-key-id\", \"your-api-key\"),\n    )\n    if err != nil {\n        log.Fatal(err)\n    }\n\n    ctx := context.Background()\n\n    // Search incidents using iterator\n    for incident, err := range client.Incidents.Search(ctx, \u0026xsoar.IncidentFilter{\n        Status: []xsoar.IncidentStatus{xsoar.StatusActive},\n    }) {\n        if err != nil {\n            log.Fatal(err)\n        }\n        fmt.Printf(\"Incident: %s - %s\\n\", incident.ID, incident.Name)\n    }\n}\n```\n\n## Authentication\n\nXSOAR 8.x / XSIAM uses advanced API key authentication with two headers:\n\n| Header | Value |\n|--------|-------|\n| `x-xdr-auth-id` | API Key ID |\n| `Authorization` | API Key |\n\nGenerate API keys in XSOAR/XSIAM under **Settings \u003e API Keys**.\n\n## Usage\n\n### Client Configuration\n\n```go\nclient, err := xsoar.NewClient(\n    xsoar.WithBaseURL(\"https://api-tenant.xdr.us.paloaltonetworks.com\"),\n    xsoar.WithAPIKey(keyID, apiKey),\n    xsoar.WithTimeout(30 * time.Second),    // optional\n    xsoar.WithHTTPClient(customClient),     // optional\n    xsoar.WithUserAgent(\"my-app/1.0\"),      // optional\n)\n```\n\n### Searching Incidents\n\n```go\n// Using iterator (fetches pages lazily)\nfilter := \u0026xsoar.IncidentFilter{\n    Status:   []xsoar.IncidentStatus{xsoar.StatusActive},\n    Severity: []xsoar.Severity{xsoar.SeverityHigh, xsoar.SeverityCritical},\n}\n\nfor incident, err := range client.Incidents.Search(ctx, filter) {\n    if err != nil {\n        return err\n    }\n    process(incident)\n}\n\n// Collect all results into a slice\nincidents, err := xsoar.Collect(client.Incidents.Search(ctx, filter))\n\n// Get first N results\nincidents, err := xsoar.CollectN(client.Incidents.Search(ctx, filter), 10)\n\n// Get first result only\nincident, err := xsoar.First(client.Incidents.Search(ctx, filter))\n\n// Low-level pagination control\npage, err := client.Incidents.SearchPage(ctx, filter, \u0026xsoar.PageOptions{\n    Offset: 0,\n    Limit:  100,\n})\n```\n\n### CRUD Operations\n\n```go\n// Get incident by ID\nincident, err := client.Incidents.Get(ctx, \"inc-123\")\n\n// Create incident\nincident, err := client.Incidents.Create(ctx, \u0026xsoar.CreateIncidentRequest{\n    Name:     \"Security Alert\",\n    Type:     \"Malware\",\n    Severity: xsoar.SeverityHigh,\n    CustomFields: map[string]any{\n        \"source\": \"SIEM\",\n    },\n})\n\n// Update incident\nseverity := xsoar.SeverityCritical\nowner := \"analyst@company.com\"\nerr := client.Incidents.Update(ctx, \"inc-123\", \u0026xsoar.UpdateIncidentRequest{\n    Severity: \u0026severity,\n    Owner:    \u0026owner,\n})\n\n// Close incident\nerr := client.Incidents.Close(ctx, \"inc-123\", \u0026xsoar.CloseIncidentRequest{\n    Reason: \"Resolved\",\n    Notes:  \"False positive confirmed\",\n})\n\n// Delete incident\nerr := client.Incidents.Delete(ctx, \"inc-123\")\n```\n\n### Per-Request Options\n\n```go\nincident, err := client.Incidents.Get(ctx, \"inc-123\",\n    xsoar.WithRequestID(\"trace-abc-123\"),\n    xsoar.WithHeader(\"X-Custom-Header\", \"value\"),\n)\n```\n\n## Error Handling\n\nAll errors implement the standard `error` interface and can be inspected using `errors.As()`:\n\n```go\nincident, err := client.Incidents.Get(ctx, \"inc-123\")\nif err != nil {\n    var authErr *xsoar.AuthenticationError\n    var notFoundErr *xsoar.NotFoundError\n    var validationErr *xsoar.ValidationError\n    var rateLimitErr *xsoar.RateLimitError\n    var serverErr *xsoar.ServerError\n\n    switch {\n    case errors.As(err, \u0026authErr):\n        log.Fatal(\"Invalid credentials\")\n    case errors.As(err, \u0026notFoundErr):\n        log.Printf(\"Incident %s not found\", notFoundErr.ResourceID)\n    case errors.As(err, \u0026validationErr):\n        log.Printf(\"Validation error: %s\", validationErr.Message)\n    case errors.As(err, \u0026rateLimitErr):\n        log.Printf(\"Rate limited, retry after %s\", rateLimitErr.RetryAfter)\n    case errors.As(err, \u0026serverErr):\n        log.Printf(\"Server error: %s\", serverErr.Message)\n    default:\n        log.Printf(\"Error: %v\", err)\n    }\n}\n```\n\n## Models\n\n### Severity Levels\n\n| Constant | Value | String |\n|----------|-------|--------|\n| `SeverityUnknown` | 0 | \"Unknown\" |\n| `SeverityInfo` | 1 | \"Info\" |\n| `SeverityLow` | 2 | \"Low\" |\n| `SeverityMedium` | 3 | \"Medium\" |\n| `SeverityHigh` | 4 | \"High\" |\n| `SeverityCritical` | 5 | \"Critical\" |\n\n### Incident Status\n\n| Constant | Value |\n|----------|-------|\n| `StatusActive` | \"Active\" |\n| `StatusPending` | \"Pending\" |\n| `StatusDone` | \"Done\" |\n| `StatusArchived` | \"Archive\" |\n\n## Iterator Helpers\n\nThe package provides helper functions for working with `iter.Seq2[T, error]` iterators:\n\n```go\n// Collect all items\nitems, err := xsoar.Collect(iterator)\n\n// Collect up to N items\nitems, err := xsoar.CollectN(iterator, 10)\n\n// Get first item (returns ErrEmptyIterator if empty)\nitem, err := xsoar.First(iterator)\n\n// Take first N items (returns new iterator)\nlimited := xsoar.Take(iterator, 5)\n\n// Filter items\nfiltered := xsoar.Filter(iterator, func(i *xsoar.Incident) bool {\n    return i.Severity \u003e= xsoar.SeverityHigh\n})\n\n// Transform items\nmapped := xsoar.Map(iterator, func(i *xsoar.Incident) string {\n    return i.ID\n})\n```\n\n## Testing\n\nThe package provides interfaces that can be mocked using [mockery](https://github.com/vektra/mockery):\n\n```bash\ngo generate ./...\n```\n\nExample test:\n\n```go\nfunc TestMyService(t *testing.T) {\n    mockIncidents := mocks.NewIncidentService(t)\n    mockIncidents.On(\"Get\", mock.Anything, \"inc-123\", mock.Anything).\n        Return(\u0026xsoar.Incident{ID: \"inc-123\", Name: \"Test\"}, nil)\n\n    // Use mockIncidents in your tests\n}\n```\n\n## Requirements\n\n- Go 1.24 or later\n- XSOAR 8.x or XSIAM (legacy XSOAR versions not supported)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftphakala%2Fgo-xsoar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftphakala%2Fgo-xsoar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftphakala%2Fgo-xsoar/lists"}