deepfence / deepfence/ThreatMapper

REST API v1.5 docs seems to be out of date

Open
#496 0 comments 0 reactions 1 assignee Claimed by @saurabh2253 View on GitHub
bug needs-triage
Dominant language
TypeScript
Stars
5.3k
Forks
631
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
Some endpoints from the API docs responds with 404 on a deployed version, such as the https://deepfence.github.io/deepfence_runtime_api/#operation--deepfence-v1.5-classtype-intent-get endpoint

```console
$ curl --oauth2-bearer "$DEEPFENCE_TOKEN" -ksS https://localhost:8443/deepfence/v1.5/classtype-intent

404 Not Found

Not Found


The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.


```

Also, is the API on a different version scheme than ThreatMapper? Considering ThreatMapper v1.3.1 and API v1.5?

**To Reproduce**

1. Deploy the helm chart to kubernetes
2. Port forward the router service

```sh
kubectl port-forward svc/deepfence-router 8443:443
```

4. Generate auth token in to env var `DEEPFENCE_TOKEN`
5. Run above cURL command
6. See error

**Expected behavior**
Above cURL command to respond with HTTP 200 status code and JSON body

**Components/Services affected**

- [ ] UI/Frontend
- [x] API/Backend
- [ ] Agent
- [ ] Deployment/YAMLs
- [ ] CI/CD Integration
- [ ] Other (specify)

**Additional context**
Running API Docker image `deepfenceio/deepfence_api_ce:1.3.1`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.