Get a detection group
GET /api/v1/public/detection-groups/{groupId}
GET /api/v1/public/detection-groups/{groupId}Fetch a specific public detection-groups.
Operation ID: get_api_v1_public_detection_groups_groupId.
Authentication
Choose a credential. Each row is an accepted alternative; access also depends on current roles, project bindings, and entitlements.
| Credential | Carrier | OAuth scopes |
|---|---|---|
ServiceAccountBearerAuth | Authorization: Bearer | See credential policy |
OAuth2 | Authorization: Bearer | configuration:read |
For OAuth and service-account credentials, send the selected project UUID in x-project-id, including when the header is optional for legacy keys.
Service-account tokens need the corresponding functional scopes listed for OAuth, as well as an active binding and role for the selected project.
Availability
This operation belongs to the standard API surface. Authentication and authorization still apply.
Request parameters
| Name | Location | Required | Type / allowed values | Description / constraints |
|---|---|---|---|---|
groupId | path | Yes | string | groupId path parameter; format: uuid; Pattern constrained; see the downloadable schema. |
x-project-id | header | Yes | string | x-project-id header parameter; Required service-account or OAuth project selection; format: uuid; Pattern constrained; see the downloadable schema. |
Request example
Replace placeholder IDs and environment variables with values from your authorized project. Credentials are expanded into curl's stdin configuration, not its command arguments. Keep shell tracing off and do not log this configuration. For requests with a body, put a payload matching the schema in request-body.txt; form requests use URL-encoded content.
curl --fail-with-body --silent --show-error --config - <<CURL_CONFIG
request = "GET"
header = "Authorization: Bearer ${NEATLOGS_TOKEN}"
header = "x-project-id: ${NEATLOGS_PROJECT_ID}"
url = "https://app.neatlogs.com/api/v1/public/detection-groups/<groupId>"
CURL_CONFIGResponses
| Status | Description | Content type |
|---|---|---|
200 | Detection group metadata | application/json |
400 | Invalid public API request | application/problem+json |
401 | Missing or invalid public API credential | application/problem+json |
403 | Public API request is not authorized | application/problem+json |
404 | Detection group not found | application/problem+json |
409 | Public API request conflict | application/problem+json |
413 | Public API request body too large | application/problem+json |
415 | Unsupported public API request body | application/problem+json |
429 | Public API rate limit exceeded | application/problem+json |
500 | Internal server error | application/problem+json |
503 | Public API credential, project context, or rate limiting unavailable. Backend is draining; retry after the Retry-After delay. | application/problem+json, application/json |
200 response fields
Content type: application/json.
| Field | Type / allowed values | Required in parent | Description / constraints |
|---|---|---|---|
$ | object | Yes | additionalProperties: false |
data | object | Yes | additionalProperties: false |
data.createdAt | string | Yes | format: date-time; Pattern constrained; see the downloadable schema. |
data.id | string | Yes | format: uuid; Pattern constrained; see the downloadable schema. |
data.name | string | Yes | minLength: 1; maxLength: 255 |
data.updatedAt | string | Yes | format: date-time; Pattern constrained; see the downloadable schema. |
requestId | string | Yes | Pattern constrained; see the downloadable schema. |
success | true | Yes | — |
Response headers
| Header | Description / constraints |
|---|---|
RateLimit-Limit | Effective request ceiling for the current window; minimum: 1 |
RateLimit-Remaining | Requests remaining in the current window; minimum: 0 |
RateLimit-Reset | Unix timestamp in seconds when the current window resets; minimum: 0 |
X-NeatLogs-RateLimit-Degraded | Whether bounded emergency enforcement is active; — |
X-NeatLogs-RateLimit-Limit | Effective request ceiling for the current window; minimum: 1 |
X-NeatLogs-RateLimit-Policy | Applied pre-authentication or authenticated rate class; — |
X-NeatLogs-RateLimit-Remaining | Requests remaining in the current window; minimum: 0 |
X-NeatLogs-RateLimit-Reset-After | Whole seconds until the current window resets; minimum: 1 |
X-NeatLogs-RateLimit-Version | NeatLogs rate-limit contract version; — |
X-Request-Id | Server-owned request correlation identifier; Pattern constrained; see the downloadable schema. |
Failures use Problem Details. For exact validation patterns and all response schemas, download the OpenAPI specification.
