Skip to content
Updawg

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

GET
/v1/orgs/{org}/compliance/exports
curl --request GET \
  --url https://api.updawg.net/v1/orgs/example/compliance/exports

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Responses

Section titled “Responses”

200

Section titled “200”

The 20 most recent exports, newest first.

Media typeapplication/json
object
exports
required

The most recent, newest first.

Array<object>
object
bytes
integer | null format: int64
created_at
required
string format: date-time
download

Where to GET the file, while it can be: the API path, relative to the API’s own address.

string | null
error

Why it failed.

string | null
expires_at
required

After this the file is no longer handed out.

string format: date-time
filename

What the download is called, once ready.

string | null
finished_at
string | null format: date-time
group
One of:

The group as it was named when the export was asked for. Absent for the whole organization.

object
id
required
string
name
required
string
id
required

exp_….

string
kind
required

What an export contains.

string
Allowed values: hosts_csv resolutions_csv report_pdf
requested_by

usr_…; absent once that person’s account is gone.

string | null
rows

Data rows, for a CSV.

integer | null format: int64
since
required
string format: date-time
status
required

Where an export is.

string
Allowed values: queued running ready failed
until
required
string format: date-time

Example 

{
  "exports": [
    {
      "kind": "hosts_csv",
      "status": "queued"
    }
  ]
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "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

Example generated

{
  "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

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

421

Section titled “421”

The organization’s data is in another region (wrong-region, DAWG-159). detail names that region’s API; send the request there.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "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

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}