Skip to content
Updawg

`GET /v1/orgs/{org}/compliance/export`.

GET
/v1/orgs/{org}/compliance/export
curl --request GET \
  --url 'https://api.updawg.net/v1/orgs/example/compliance/export?dataset=example'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Query Parameters

Section titled “Query Parameters”
dataset
required
string

hosts: every host’s standing now, one row each. resolutions: every exposure that ended in the period, with its latency.

since
string format: date-time

Start of the period, for resolutions (RFC 3339). Default: 90 days before until.

until
string format: date-time

End of the period, exclusive. Default: now.

group
string

Only the hosts this group (grp_…) resolves to now.

Responses

Section titled “Responses”

200

Section titled “200”

A CSV download.

Media typetext/csv
string

400

Section titled “400”

An unknown or repeated parameter, a dataset other than hosts or resolutions, a bad period or group, or more resolutions than one export holds — narrow the period.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Not permitted for this role. Or the plan does not include compliance reports (Business): plan-required.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such organization, or not yours.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}