List all policies

GET

/v1/policies

const url = 'http://api.disclosebot.localdev:3000/v1/policies';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/policies \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Query Parameters

page[number]

integer

page[size]

integer

Responses

200

Successful

application/vnd.api+json

object

data

required

Array<object>

object

required

string format: uuid

type

required

string

Allowed values: policy

attributes

required

object

name

string

short_description

string

nullable

point_of_contact

string

nullable

cvd_timeline

integer

nullable

safe_harbor

string

Allowed values: full partial none

offers_bounty

boolean

nullable

offers_swag

boolean

nullable

hall_of_fame

boolean

nullable

contact_url

string

nullable

securitytxt_url

string

nullable

hosted_policy_url

string

nullable

public_disclosure

boolean

nullable

launch_date

string format: date-time

nullable

policy_url_status

string

nullable

creation_mode

string

hosting_mode

string

custom_domain

string

nullable

published_at

string format: date-time

nullable

shortcode

string

branding

object

primary_color

string

secondary_color

string

accent_color

string

font_heading

string

font_body

string

google_fonts

Array<string>

created_at

string format: date-time

updated_at

string format: date-time

in_scope_assets

Array<object>

object

string format: uuid

kind

string

value

string

short_description

string

nullable

out_of_scope_assets

Array<object>

object

string format: uuid

kind

string

value

string

short_description

string

nullable

relationships

object

organization

object

data

object

required

string format: uuid

type

required

string

Allowed values: organization

policy_template

object

data

object

string format: uuid

type

string

Allowed values: policy_template

assets

object

data

Array<object>

object

string format: uuid

type

string

Allowed values: asset

briefs

object

data

Array<object>

object

string format: uuid

type

string

Allowed values: brief

Example

{
  "data": [
    {
      "type": "policy",
      "attributes": {
        "safe_harbor": "full"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organization"
          }
        },
        "policy_template": {
          "data": {
            "type": "policy_template"
          }
        },
        "assets": {
          "data": [
            {
              "type": "asset"
            }
          ]
        },
        "briefs": {
          "data": [
            {
              "type": "brief"
            }
          ]
        }
      }
    }
  ]
}

401

Unauthorized